home *** CD-ROM | disk | FTP | other *** search
/ Amiga Games: Greatest Hits 1996 / Amiga Games: Greatest Hits 1996.iso / archive / userbox / publicdomain / frexxed.lha / frexxed / fpl / WordPro.FPL.README < prev    next >
Text File  |  1996-05-20  |  6KB  |  138 lines
  1. #############################################################################
  2. File:        WordPro.FPL
  3. Author:        Daniel Stenberg
  4. Email:        Daniel.Stenberg@sth.frontec.se
  5. Short:        Paragraph oriented word wrap and much more.
  6. Version:    1.3
  7. Date:        11.4.96
  8. Local settings:    a few
  9. Global settings: a few
  10. Keysequence:
  11. Type:        hooks/keys/mode
  12. Prereq:
  13. Copyright:    (C) by FrexxWare 1996
  14. #############################################################################
  15.  
  16. FUNCTION
  17.   The main function of this program is a *TRUE* word-processor style
  18. interactive paragraph oriented word wrap. With this, I mean word wrapping
  19. where all newlines inserted because a word wrap was required, are called
  20. 'soft newlines', and when i.e a line with a 'soft' newline gets short enough,
  21. the first word from the line below will get moved to the line of the deletion.
  22.   You'll understand it if you try it.
  23.  
  24.   All soft newlines will be visible with '^'-characters. They are left visible
  25. only for the user to better control and know where they are and how the buffer
  26. is treated.
  27.  
  28.   This program also features functions for:
  29.  * Open files into wordpro-mode. Adds 'soft' newlines to all lines it thinks
  30.    are part of the same paragraph. It will also wrap all lines longer than
  31.    the defined allowed width.
  32.  * Wrap block. Does a similar operation like the 'Open' but instead of a new
  33.    file, it operates on the marked block.
  34.  * Preferences customization. Brings up a window which lets the user select
  35.    a few things.
  36.  * Reformat the current paragraph or buffer. If you i.e change the right
  37.    margin after you've written one or more paragraphs, these functions
  38.    re-format them for you. The functions are just a small re-write of the
  39.    function filltext(), brought to you by Jesper Skov. For detailed docs
  40.    about that, read FillText.FPL.README
  41.  
  42. MENU ITEMS
  43.   Open...    - Opens and wraps a file
  44.   Save...    - Saves a file. Wrapped lines are stored as the 'wordpro_save'
  45.                variable tells.
  46.   Prefs...   - Brings up the prefs window, see below
  47.  
  48.   Reformat   -
  49.     Paragraph  - Reformat the current paragraph, Best used if i.e the margin
  50.                  is changed.
  51.     Buffer     - Reformats all paragraphs in the buffer.
  52.  
  53.   WordProify - "init" text not previously used with WordPro. If you i.e enter
  54.                a buffer with lots of text in and you'd like to 'WordPro-ify'
  55.                it, these are the functions to use.
  56.     Block      - WordPro-ify the currently marked block.
  57.     Buffer     - WordPro-ify the current buffer.
  58.  
  59. PREFERENCES
  60.  - 'fill_text_US' is used by the reformat functions, invoked as "Reformat->
  61.    Paragraph" or "Reformat->Buffer" from the WordPro menu. It controls
  62.    whether the paragraph is supposed to get formatted the "american way"
  63.    which means two spaces after each '.' in the paragraph. (Idea cortesy
  64.    of Jesper Skov.)
  65.  
  66.  - 'wall_right' - Where the right edge is - where all wraps should occur.
  67.  
  68.  - 'wordpro' mode on/off for the current buffer.
  69.  
  70.  - 'wordpro_fitprev', which if disabled makes the program never check if
  71.    the first word of the current line fits on the line above. Slight speed
  72.    improvement on slower machines.
  73.  
  74.  - 'wordpro_save' - Save mode. The user can select a few ways how to save all
  75.    buffers in 'wordpro' mode:
  76.    RAW saves the buffer just as you see it, including the raw codes for soft
  77.      newlines. If you intend to edit the file again in 'wordpro' mode, you
  78.      should save it with this, otherwise there is hardly any reason to do it.
  79.    SOFTS TOO saves the buffer with all newlines left, including the soft ones.
  80.      This will save the buffer just like it looks on screen, but without the
  81.      soft newline characters.
  82.    ONLY HARDS replaces all soft newlines with spaces before saving. Only hard
  83.      newlines will be left as real newlines.
  84.    QUERY makes the save operation query which save mode to use every time save
  85.      is requested.
  86.  
  87.  - 'wordpro_open' makes all regular opens wrap the input files if enabled.
  88.    If disabled, only files loaded with the wordpro-open function will get
  89.    wrapped when read!
  90.  
  91.  
  92. HISTORY
  93.  0.1ß    - The first version I really believe actually works!
  94.  1.0    - Fixed the bug that was reported by Christer Enfors:
  95.       When adding text to the end of a line what wasn't the last line
  96.       and it wasn't previously wrapped, the cursor got on the wrong
  97.       position when it did wrap.
  98.     - Inserting a lot of spaces before the last word of a line, until
  99.       that word get wrapped, now tries to move the cursor down to
  100.       the next line instead of remaining on the first line.
  101.  1.1    - Fixed another Enfors-report. Deleting characters in a line that
  102.       makes the first word of the line below get moved to the current,
  103.       could make the screen horizontally slided, as when the cursor
  104.       reaches the 'marg_right' margin.
  105.     - Added the suggested changes Alan Beale provided me with for the
  106.       delete function.
  107.  1.2    - Improved 'delete'. Thanks to Olivier Jeannet for the report!
  108.           Delete could very easily ruin a whole document previously! ;(
  109.         - Pasting a block ending with spaces, that crossed the right margin
  110.           could confuse the wrapper.
  111.  1.3    - Made it use an alternative version of Jesper's lovely paragraph
  112.           'filler' to reformat paragraphs/buffers.
  113.         - Also added better menu items and made it better looking/ordered.
  114.         - For the first time ever, I tried the compiled version of this
  115.           program. Beautiful.
  116.  
  117. NOTES
  118.   When the cursor reaches 'marg_right' columns from the right edge of the
  119. window, the view will get slided to the side. You can alter that margin
  120. to better fit your desire and purposes.
  121.  
  122. BUGS
  123.   TAB screws up the right margin awareness. Lame, fix that!
  124.   I know there still are more. Report how to repeat 'em!
  125.  
  126. TODO
  127. * Make it quote-aware, editing quoted lines would be a KILLER! ;)
  128.  
  129. * Make it support some kind of left margin to make it useable when editing
  130.   texts that don't start in the first column.
  131.  
  132. * Spell checking. Perhaps auto-invoked on save.
  133.  
  134. * BOLD/ITALIC/UNDERLINED codes support for Spot ((C) by Nico François)
  135.  
  136. SEE ALSO
  137.   WordWrap.FPL - for a simpler and faster word wrap.
  138.